GetProxyServerInfo

SoftwareShield ClientProtector COM Component > ClientProtector (SSCProtector) Reference > GetProxyServerInfo

## GetProxyServerInfo

The GetProxyServerInfo function returns proxy server information stored inside the currently loaded license.

###### Syntax

HRESULT GetProxyServerInfo (

VARIANT_BOOL * UseProxyServer,

BSTR * ProxyServerName,

long * ProxyPort,

VARIANT_BOOL * UseProxyAuthentication,

BSTR * ProxyUserName,

BSTR * ProxyPassword,

VARIANT_BOOL * Success

) ;

###### Parameters

UseProxyServer

[OUT] This is (a pointer to) a boolean value that returns with true if the ClientProtector should use the proxy server information in communicating with the CheckPoint server, false otherwise.

ProxyServerName

[OUT] This is (a pointer to) a string value that returns with the proxy server name (or IP) that the ClientProtector should use to locate the proxy server when performing CheckPoint communication. This value is ignored by the ClientProtector if UseProxyServer is false.

ProxyPort

[OUT] This is (a pointer to) a numeric value that returns with the proxy server port number (usually 8080 but can be anything) that the ClientProtector should use to invoke the proxy server when performing CheckPoint communication. This value is ignored by the ClientProtector if UseProxyServer is false.

UseProxyAuthentication

[OUT] This is (a pointer to) a boolean value that returns with true if the proxy server uses authentication (only "Basic Authentication" is supported). This value is ignored by the ClientProtector if UseProxyServer is false.

ProxyUserName

[OUT] This is (a pointer to) a string value that returns with the users proxy server account name (used for authentication). This value is ignored by the ClientProtector if UseProxyServer or UseProxyAuthentication is false.

ProxyPassword

[OUT] This is (a pointer to) a string value that returns with the users proxy server password (used for authentication). This value is ignored by the ClientProtector if UseProxyServer or UseProxyAuthentication is false.

Success

[OUT] This is (a pointer to) a boolean value that returns true if the proxy server information was successfully retrieved, false otherwise. Note that this will return true even if the user does not use a proxy server. This will return false if the license was not correctly initialized with a call to StartUp.

###### Remarks

The GetProxyServerInfo function returns proxy server information stored inside the currently loaded license (if any). This information is used during any web-service communication the ClientProtector will make with your CheckPoint server (as identified by the CheckPoint Server URL).

Note that this information is only relevant to the client machine on which it runs. You may set this information both during the scope of the OnPrepareAutoActivate event handler or directly at any time using SetProxyServerInfo.

Before setting these values gathered from the user, you may wish to walk the user through a test connection to ensure they were entered correctly. To do this, use QuickTestCheckPointConnection.

About SSL (HTTPS) and Proxy Servers

Keep in mind that proxy servers generally can not act as a proxy for HTTPS (SSL) communication. HTTPS requires a secure handshake from point-to-point to enable its secure communications. A proxy server can not be in between the two participants (client and server) of an SSL communication. Most enterprises that use proxy servers allow direct outbound SSL communication for the workstations (default port 443) to allow SSL communication to work. If you are deploying your CheckPoint Server to be accessible via HTTPS only, be sure to take this into account when managing proxy server information.

###### Return Value

As with all COM function calls they return an HRESULT. HRESULT is a data type that is a 32-bit error or warning code. Check your compilers documentation for information on interpreting the HRESULT value.

###### Function Information

Exposed By Interface: | "ISSCProtector"
Exposed In COM Server Binaries: | "SSCProt.dll" and "SSCProtD.dll"